Issues

partial #1998

Commits

• feat: makes the reference interface covariant
• fix: visibility of serialize internal methods
• fix: proxy design pattern implementation for OpenAPiExample

Details

This PR:

1. clears naming confusion between IOpenAPIReferenceable and IOpenAPIReferenceHolder for who can be referenced and who references
2. introduces a new IOpenAPIReadOnlyExtensible to enable polymorphism between references and targets
3. introduces a new IOpenApiDescribedElement to enable polymorphism
4. introduces a new IOpenAPIExample interface to correct the proxy implementation. To maximize reusability this interface derives from IOpenApiDescribedElement, IOpenApiSerializable and IOpenApiReadOnlyExtensible. It also defines getters only for the properties that are specific to the OpenAPIexample type. Only OpenApiExample implements the setters, this has multiple benefits including immediate feedback to the user from the compiler when they are getting confused between the target and a reference and risk mutating the target instead of the local reference
5. updates all the DOM to return IOpenApiExample
6. removes duplicate local fields for summary and description in the OpenApiExampleReference since those can be stored in the reference type (fields already existing)
7. removes all virtual modifiers in OpenAPIExample
8. makes OpenAPIExample implement IOpenAPIExample, and switches to inheritdoc comments
9. makes the copy constructor of OpenAPIexample accept an IOpenAPIExample
10. removes reference properties from OpenAPIExample
11. implements IOpenAPIReferenceHolder in OpenAPIExampleReference, removing the local reference property
12. removes setters for custom properties in OpenAPIExampleReference to avoid any confusion to what is being mutated.
13. implements a "CopyReferenceAsTargetElementWithOverrides" to create throw away objects during serialization of references being inlined and account for overrides of description and summary

steps 4 and below need to be replicated for all other types.